home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / FileEntry.pod < prev    next >
Encoding:
Text File  |  2006-06-19  |  3.6 KB  |  224 lines

  1. =head1 NAME
  2.  
  3. Gnome2::FileEntry
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Glib::Object::_Unregistered::GInitiallyUnowned
  9.        +----Gtk2::Object
  10.             +----Gtk2::Widget
  11.                  +----Gtk2::Container
  12.                       +----Gtk2::Box
  13.                            +----Gtk2::VBox
  14.                                 +----Gnome2::FileEntry
  15.  
  16. =head1 INTERFACES
  17.  
  18.   Gtk2::Atk::ImplementorIface
  19.   Gtk2::Editable
  20.  
  21.  
  22. =head1 METHODS
  23.  
  24. =head2 widget = Gnome2::FileEntry-E<gt>B<new> ($history_id, $browse_dialog_title)
  25.  
  26. =over
  27.  
  28. =over
  29.  
  30. =item * $history_id (string) 
  31.  
  32. =item * $browse_dialog_title (string) 
  33.  
  34. =back
  35.  
  36. =back
  37.  
  38. =head2 $fentry-E<gt>B<set_default_path> ($path)
  39.  
  40. =over
  41.  
  42. =over
  43.  
  44. =item * $path (string) 
  45.  
  46. =back
  47.  
  48. =back
  49.  
  50. =head2 boolean = $fentry-E<gt>B<get_directory_entry> 
  51.  
  52. =over
  53.  
  54. =back
  55.  
  56. =head2 $fentry-E<gt>B<set_directory_entry> ($directory_entry)
  57.  
  58. =over
  59.  
  60. =over
  61.  
  62. =item * $directory_entry (boolean) 
  63.  
  64. =back
  65.  
  66. =back
  67.  
  68. =head2 $fentry-E<gt>B<set_filename> ($filename)
  69.  
  70. =over
  71.  
  72. =over
  73.  
  74. =item * $filename (string) 
  75.  
  76. =back
  77.  
  78. =back
  79.  
  80. =head2 string = $fentry-E<gt>B<get_full_path> ($file_must_exist)
  81.  
  82. =over
  83.  
  84. =over
  85.  
  86. =item * $file_must_exist (boolean) 
  87.  
  88. =back
  89.  
  90. =back
  91.  
  92. =head2 widget = $fentry-E<gt>B<gnome_entry> 
  93.  
  94. =over
  95.  
  96. =back
  97.  
  98. =head2 widget = $fentry-E<gt>B<gtk_entry> 
  99.  
  100. =over
  101.  
  102. =back
  103.  
  104. =head2 boolean = $fentry-E<gt>B<get_modal> 
  105.  
  106. =over
  107.  
  108. =back
  109.  
  110. =head2 $fentry-E<gt>B<set_modal> ($is_modal)
  111.  
  112. =over
  113.  
  114. =over
  115.  
  116. =item * $is_modal (boolean) 
  117.  
  118. =back
  119.  
  120. =back
  121.  
  122. =head2 $fentry-E<gt>B<set_title> ($browse_dialog_title)
  123.  
  124. =over
  125.  
  126. =over
  127.  
  128. =item * $browse_dialog_title (string) 
  129.  
  130. =back
  131.  
  132. =back
  133.  
  134.  
  135. =head1 PROPERTIES
  136.  
  137. =over
  138.  
  139. =item 'browse-dialog-title' (string : readable / writable)
  140.  
  141. Title for the Browse file dialog.
  142.  
  143. =item 'default-path' (string : readable / writable)
  144.  
  145. Default path for the Browse file window.
  146.  
  147. =item 'directory-entry' (boolean : readable / writable)
  148.  
  149. Whether the file entry is being used to enter directory names or complete filenames.
  150.  
  151. =item 'filechooser-action' (Gtk2::FileChooserAction : readable / writable)
  152.  
  153. The type of operation that the file selector is performing.
  154.  
  155. =item 'filename' (string : readable / writable)
  156.  
  157. Filename that should be displayed in the file entry.
  158.  
  159. =item 'gnome-entry' (Gnome2::Entry : readable)
  160.  
  161. GnomeEntry that the file entry uses for entering filenames.  You can use this property to get the GnomeEntry if you need to modify or query any of its parameters.
  162.  
  163. =item 'gtk-entry' (Gtk2::Entry : readable)
  164.  
  165. GtkEntry that the file entry uses for entering filenames.  You can use this property to get the GtkEntry if you need to modify or query any of its parameters.
  166.  
  167. =item 'history-id' (string : readable / writable)
  168.  
  169. Unique identifier for the file entry.  This will be used to save the history list.
  170.  
  171. =item 'modal' (boolean : readable / writable)
  172.  
  173. Whether the Browse file window should be modal.
  174.  
  175. =item 'use-filechooser' (boolean : readable / writable)
  176.  
  177. Whether to use the new GtkFileChooser widget or the GtkFileSelection widget to select files.
  178.  
  179. =back
  180.  
  181.  
  182. =head1 SIGNALS
  183.  
  184. =over
  185.  
  186. =item B<activate> (Gnome2::FileEntry)
  187.  
  188. =item B<browse-clicked> (Gnome2::FileEntry)
  189.  
  190. =back
  191.  
  192.  
  193. =head1 ENUMS AND FLAGS
  194.  
  195. =head2 enum Gtk2::FileChooserAction
  196.  
  197. =over
  198.  
  199. =item * 'open' / 'GTK_FILE_CHOOSER_ACTION_OPEN'
  200.  
  201. =item * 'save' / 'GTK_FILE_CHOOSER_ACTION_SAVE'
  202.  
  203. =item * 'select-folder' / 'GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER'
  204.  
  205. =item * 'create-folder' / 'GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER'
  206.  
  207. =back
  208.  
  209.  
  210.  
  211. =head1 SEE ALSO
  212.  
  213. L<Gnome2>, L<Glib::Object>, L<Glib::Object::_Unregistered::GInitiallyUnowned>, L<Gtk2::Object>, L<Gtk2::Widget>, L<Gtk2::Container>, L<Gtk2::Box>, L<Gtk2::VBox>
  214.  
  215. =head1 COPYRIGHT
  216.  
  217. Copyright (C) 2003-2004 by the gtk2-perl team.
  218.  
  219. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  220.  
  221.  
  222. =cut
  223.  
  224.